BaseSubsystem.GetBoolVariable method
Gets the details of a user-defined variable in bool.
Namespace: IntervalZero.KINGSTAR.Base.Class
Assembly: IntervalZero.KINGSTAR.Base.Class (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0
Syntax
IUserVariable<bool> GetBoolVariable(
string Name,
IUserVariable Parent = null
)
Function GetBoolVariable(
Name As String,
Parent = null As IUserVariable
) As IUserVariable(Of Boolean)
Parameters
Name
Type: string
The name of a variable.
Parent
Type: IUserVariable
Default value: null
The parent folder of IUserVariable. By default, it gets variables from the root folder.
Remarks
- The Name string uses UTF-16 encoding.
- The variable can be used in KINGSTAR Scope and a real-time log.
Return value
Type: IUserVariable<bool>
Returns a user-defined variable in bool.
Usable EtherCAT states
ecatOffline, ecatInit, ecatBoot, ecatPreOP, ecatSafeOP, ecatOP
See also